docs: fill CLI reference gaps for data prep and rollout collection#1675
Open
lbliii wants to merge 2 commits into
Open
docs: fill CLI reference gaps for data prep and rollout collection#1675lbliii wants to merge 2 commits into
lbliii wants to merge 2 commits into
Conversation
- ng_materialize_prompts: full parameter table, example, and note vs ng_prepare_data (closes #1347). - resume_from_cache: params-table entries plus Resume Interrupted Runs section (closes #1239). - Generation parameters: ++responses_create_params.<field> Hydra overrides with shallow-merge behavior documented (closes #637). - PyPI-first installation tab in installation.mdx (closes #1191). - Mirror CLI reference and installation changes into v0.3.0 stable docs. Signed-off-by: Lawrence Lane <llane@nvidia.com>
lbliii
changed the title
|
🌿 Preview your docs: https://nvidia-preview-lbliii-docs-cli-dco-fix.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
Contributor
Resolve cli-commands.mdx conflict by adopting main's gym CLI rewrite and porting doc-gap content (resume interrupted runs, shallow-merge Hydra note, dataset render vs collate guidance) into the new structure. Signed-off-by: Lawrence Lane <llane@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fills documented gaps in the CLI reference and installation pages. All CLI additions were verified against
nemo_gym/prompt.pyandnemo_gym/rollout_collection.py.ng_materialize_prompts— full parameter table, example, and a note clarifying when to use it vs.ng_prepare_data. Closes docs: add missing CLI commands to reference and clarify when to use each #1347.resume_from_cache— params-table entries forng_collect_rolloutsandng_e2e_collect_rollouts, plus a Resume Interrupted Runs section covering the*_materialized_inputs.jsonlartifact, per-rollout incremental flush,(task_index, rollout_index)matching, fallback behavior, and the stale-cache footgun. Closes docs: document resume_from_cache for rollout collection #1239.temperature,top_p, andmax_output_tokensare passed via++responses_create_params.<field>rather than as standalone flags. Documents shallow (top-level) merge behavior for nested overrides. Closes bug: could not find temperature CLI params due to docs segmented control #637.installation.mdx. Closes docs: swap install path to pip install nemo-gym with 0.3.0 PyPI release #1191.Review feedback addressed
responses_create_paramsoverrides use a shallow merge (dict | overridesin_preprocess_rows_from_config), so nested Hydra overrides replace the entire nested dict rather than deep-merging fields.Verification
npm run check(fern check) passes with 0 errors.Note: Replaces #1498. That PR's branch (
docs/cli-reference-cleanup) could not be rewritten due to branch protection (no force-push/delete); an unsigned commit (91526fce) left DCO failing. This PR uses a single signed commit onlbliii/docs-cli-dco-fix.